Developer Documentation

QuickTime 4 API Documentation

QuickTime 4 Reference

| Previous | Chapter Contents | Chapter Top | Next |

SMPTE Wipe Effects

kWipeTransitionType ('smpt')

This effect is an implementation of the 34 wipes from ANSI/SMPTE 258M-1993, plus two Apple-defined wipes that choose a random effect. These are a series of masking or "reveal" type wipes that take place between two sources. For full definitions of these 34 wipes and what they look like, refer to the SMPTE documentation.

Example:

The SMPTE wipe effects take two sources and seven parameters.

Parameters

Use the descriptions below to help you understand what the parameters do. To learn how to use parameter atoms, see "Adding Video Effects to a QuickTime Movie" .

Name

Code

QTAtom Type

Description

Percentage

'pcnt'

kParameterTypeDataFixed

Always a tween

This parameter contains a tween. As the effect progresses, QuickTime renders the frame of the effect indicated by the tween's current value, as a percentage of the whole effect. For example, if the tween goes from 0 to 100, the effect renders completely; if the tween goes from 25 to 75, rendering begins 25% into the effect and terminates 75% through the effect.

Wipe ID

'wpID'

kParameterTypeDataEnum

The SMPTE ID for the effect. By setting this parameter, you control which of the 47 available wipes is used. See the enumeration list below.

Soft border

'soft'

kParameterTypeDataBitField

If this parameter contains true , the border drawn around the second source is blurred.

Border width

'widt'

kParameterTypeDataFixed

Can be a tween

The width, in pixels, of a border that is drawn around the second source.

Border color

'bclr'

kParameterTypeDataRGBValue

Can be a tween

The RGB color of the border around the second source.

Horizontal repeat

'hori'

kParameterTypeDataLong

Can be a tween

The number of horizontal repeats of the effect that are executed in a single source.

Vertical repeat

'vert'

kParameterTypeDataLong

Can be a tween

The number of vertical repeats of the effect that are executed in a single source.

Wipe ID Enum

The Wipe ID parameter can take the following values:

Value

String

1 Slide horizontal
2 Slide vertical
3 Top left
4 Top right
5 Bottom right
6 Bottom left
7 Four corner
8 Four box
21 Barn vertical
22 Barn horizontal
23 Top center
24 Right center
25 Bottom center
26 Left center
41 Diagonal left down
42 Diagonal right down
43 Vertical bow tie
44 Horizontal bow tie
45 Diagonal left out
46 Diagonal right out
47 Diagonal cross
48 Diagonal box
61 Filled V
62 Filled V right
63 Filled V bottom
64 Filled V left
65 Hollow V
66 Hollow V right
67 Hollow V bottom
68 Hollow V left
71 Vertical zig zag
72 Horizontal zig zag
73 Vertical barn zig zag
74 Horizontal barn zig zag
409 Random effect (One of the 133 SMPTE effects is chosen at random)
501 Random wipe (One of the 34 SMPTE wipe effects is chosen at random)

© 1999 Apple Computer, Inc.

| Previous | Chapter Contents | Chapter Top | Next |